Skip to content

Comments

feat: changelogs within npmx#1233

Draft
WilcoSp wants to merge 35 commits intonpmx-dev:mainfrom
WilcoSp:feat/changelog-1
Draft

feat: changelogs within npmx#1233
WilcoSp wants to merge 35 commits intonpmx-dev:mainfrom
WilcoSp:feat/changelog-1

Conversation

@WilcoSp
Copy link
Contributor

@WilcoSp WilcoSp commented Feb 8, 2026

This pr will add the possibility to view the changelog.md & releases from a package's github (maybe others) repo within npmx.
This will make it easier to see the changelogs while not needed to leave npmx and allowing quicker access.

This pr is the first pr of #501


Currently this pr is in draft mode to allow for previewing while I still work on this pr.

If you've feedback about this pr leave a comment behind.
if you wish something to be added, please check & comment at #501

@vercel
Copy link

vercel bot commented Feb 8, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
npmx.dev Ready Ready Preview, Comment Feb 23, 2026 8:13pm
2 Skipped Deployments
Project Deployment Actions Updated (UTC)
docs.npmx.dev Ignored Ignored Preview Feb 23, 2026 8:13pm
npmx-lunaria Ignored Ignored Feb 23, 2026 8:13pm

Request Review

@github-actions
Copy link

github-actions bot commented Feb 8, 2026

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

File Note
lunaria/files/en-GB.json Localization changed, will be marked as complete. 🔄️
lunaria/files/en-US.json Source changed, localizations will be marked as outdated.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

@codecov
Copy link

codecov bot commented Feb 8, 2026

❌ 1 Tests Failed:

Tests completed Failed Passed Skipped
1727 1 1726 6
View the top 1 failed test(s) by shortest run time
test/unit/server/utils/readme.spec.ts > HTML output > returns sanitized html
Stack Traces | 0.0115s run time
AssertionError: expected '<h3 id="user-content-Title" data-leve…' to be '<h3 id="user-content-title" data-leve…' // Object.is equality

- Expected
+ Received

- <h3 id="user-content-title" data-level="1"><a href="#user-content-title">Title</a></h3>
+ <h3 id="user-content-Title" data-level="1"><a href="#user-content-Title">Title</a></h3>
  <p>Some <strong>bold</strong> text and a <a href="https://example.com" rel="nofollow noreferrer noopener" target="_blank">link</a>.</p>


 ❯ .../server/utils/readme.spec.ts:406:8
 ❯ node_modules/.pnpm/@voidzero-dev+vite-plus-test@0.0.0-833c515fa25cef20905a7f9affb156dfa6f151ab_@openteleme_9f07059b51462963fb1fb3cfdbd6b06a/node_modules/@voidzero-dev/vite-plus-test/dist/@vitest/runner/index.js:915:22

To view more test analytics, go to the Test Analytics Dashboard
📋 Got 3 mins? Take this short survey to help us improve Test Analytics.

@gwennlbh
Copy link

gwennlbh commented Feb 20, 2026

i have good feedback! it works fine on https://npmxdev-git-fork-wilcosp-feat-changelog-1-npmx.vercel.app/package-changes/swarpc/v/0.19.0

its not really a "stress-test" per se (as I have a tool that manages the changelog for me, so it stritctly adheres to the KAC standard), but theres a few code blocks, strong-within-code tag once, etc. version splitting works fine, and the per-version outline menu is nice ^^

edit: uhhh as it turns out i also copy paste the changes in the github releases tab so its not really testing that oops

@gwennlbh
Copy link

gwennlbh commented Feb 20, 2026

also, i have to admit that it took me quite some time to find the changelog button, i intuitively looked around the "Versions" section

i think it could be added either on each version or next to (while keeping it aligned but you get me) the community adoption button

image

@WilcoSp
Copy link
Contributor Author

WilcoSp commented Feb 20, 2026

@gwennlbh

also, i have to admit that it took me quite some time to find the changelog button, i intuitively looked around the "Versions" section

yeah might be a nice idea to have as an extra button

i think it could be added either on each version or next to (while keeping it aligned but you get me) the community adoption button

This idea antfu also has in his pr #1368 and I do also think this would be very nice to have

…gelog info endpoint will return ChangelogMarkdownInfo instead of ChangelogReleaseInfo
…ded to changelog markdown rendering

added scroll margin to the changes page
now showing the date as of when the release was made
fixed icon for changelog button at package page
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants